home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / PInterfaces / OSA.p < prev    next >
Text File  |  1996-05-01  |  53KB  |  1,483 lines
  1. {
  2.      File:        OSA.p
  3.  
  4.      Contains:    AppleScript Client Interfaces.
  5.  
  6.      Version:    Technology:    AppleScript 1.1
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT OSA;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __OSA__}
  28. {$SETC __OSA__ := 1}
  29.  
  30. {$I+}
  31. {$SETC OSAIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __ERRORS__}
  35. {$I Errors.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __APPLEEVENTS__}
  38. {$I AppleEvents.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __AEOBJECTS__}
  41. {$I AEObjects.p}
  42. {$ENDC}
  43. {$IFC UNDEFINED __COMPONENTS__}
  44. {$I Components.p}
  45. {$ENDC}
  46.  
  47. {$PUSH}
  48. {$ALIGN MAC68K}
  49. {$LibExport+}
  50.  
  51. {$IFC FOR_SYSTEM7_ONLY }
  52. {
  53. *************************************************************************
  54.     Types and Constants
  55. *************************************************************************
  56. }
  57. {
  58.     The componenent manager type code for components that
  59.         support the OSA interface defined here. 
  60. }
  61. {  0x6f736120  }
  62.  
  63. CONST
  64.     kOSAComponentType            = 'osa ';
  65.  
  66. {  0x73637074  }
  67.     kOSAGenericScriptingComponentSubtype = 'scpt';
  68.  
  69. {     Type of script document files.     }
  70. {  0x6f736173  }
  71.     kOSAFileType                = 'osas';
  72.  
  73. {
  74.         Suite and event code of the RecordedText event. 
  75.         (See OSAStartRecording, below.)
  76. }
  77. {  0x61736372  }
  78.     kOSASuite                    = 'ascr';
  79.  
  80. {  0x72656364  }
  81.     kOSARecordedText            = 'recd';
  82.  
  83. {  Selector returns boolean  }
  84. {  0x6d6f6469  }
  85.     kOSAScriptIsModified        = 'modi';
  86.  
  87. {  Selector returns boolean  }
  88. {  0x63736372  }
  89.     kOSAScriptIsTypeCompiledScript = 'cscr';
  90.  
  91. {  Selector returns boolean  }
  92. {  0x76616c75  }
  93.     kOSAScriptIsTypeScriptValue    = 'valu';
  94.  
  95. {  Selector returns boolean  }
  96. {  0x636e7478  }
  97.     kOSAScriptIsTypeScriptContext = 'cntx';
  98.  
  99. {  Selector returns a DescType which may be passed to OSACoerceToDesc  }
  100. {  0x62657374  }
  101.     kOSAScriptBestType            = 'best';
  102.  
  103. {
  104.         This selector is used to determine whether a script has source 
  105.         associated with it that when given to OSAGetSource, the call will not
  106.         fail.  The selector returns a boolean.
  107. }
  108. {  0x67737263  }
  109.     kOSACanGetSource            = 'gsrc';
  110.  
  111.     typeOSADialectInfo            = 'difo';                        {   0x6469666f    }
  112.     keyOSADialectName            = 'dnam';                        {   0x646e616d    }
  113.     keyOSADialectCode            = 'dcod';                        {   0x64636f64    }
  114.     keyOSADialectLangCode        = 'dlcd';                        {   0x646c6364    }
  115.     keyOSADialectScriptCode        = 'dscd';                        {   0x64736364    }
  116.  
  117.  
  118. TYPE
  119.     OSAError                            = ComponentResult;
  120. {  Under the Open Scripting Architecture all error results are longs  }
  121.     OSAID                                = LONGINT;
  122. {
  123.         OSAIDs allow transparent manipulation of scripts associated with
  124.          various scripting systems.
  125. }
  126.  
  127. CONST
  128.     kOSANullScript                = 0;
  129.  
  130. {  No -script constant.  }
  131.     kOSANullMode                = 0;                            {  sounds better  }
  132.     kOSAModeNull                = 0;                            {  tastes consistent  }
  133.  
  134. {
  135.         Some routines take flags that control their execution.  This constant
  136.         declares default mode settings are used.
  137. }
  138.  
  139. TYPE
  140.     OSACreateAppleEventProcPtr = ProcPtr;  { FUNCTION OSACreateAppleEvent(theAEEventClass: AEEventClass; theAEEventID: AEEventID; (CONST)VAR target: AEAddressDesc; returnID: INTEGER; transactionID: LONGINT; VAR result: AppleEvent; refCon: LONGINT): OSErr; }
  141.  
  142.     OSASendProcPtr = ProcPtr;  { FUNCTION OSASend((CONST)VAR theAppleEvent: AppleEvent; VAR reply: AppleEvent; sendMode: AESendMode; sendPriority: AESendPriority; timeOutInTicks: LONGINT; idleProc: AEIdleUPP; filterProc: AEFilterUPP; refCon: LONGINT): OSErr; }
  143.  
  144.     OSACreateAppleEventUPP = UniversalProcPtr;
  145.     OSASendUPP = UniversalProcPtr;
  146.  
  147. CONST
  148.     uppOSACreateAppleEventProcInfo = $000FEFE0;
  149.     uppOSASendProcInfo = $003FEFE0;
  150.  
  151. FUNCTION NewOSACreateAppleEventProc(userRoutine: OSACreateAppleEventProcPtr): OSACreateAppleEventUPP;
  152.     {$IFC NOT GENERATINGCFM }
  153.     INLINE $2E9F;
  154.     {$ENDC}
  155.  
  156. FUNCTION NewOSASendProc(userRoutine: OSASendProcPtr): OSASendUPP;
  157.     {$IFC NOT GENERATINGCFM }
  158.     INLINE $2E9F;
  159.     {$ENDC}
  160.  
  161. FUNCTION CallOSACreateAppleEventProc(theAEEventClass: AEEventClass; theAEEventID: AEEventID; {CONST}VAR target: AEAddressDesc; returnID: INTEGER; transactionID: LONGINT; VAR result: AppleEvent; refCon: LONGINT; userRoutine: OSACreateAppleEventUPP): OSErr;
  162.     {$IFC NOT GENERATINGCFM}
  163.     INLINE $205F, $4E90;
  164.     {$ENDC}
  165.  
  166. FUNCTION CallOSASendProc({CONST}VAR theAppleEvent: AppleEvent; VAR reply: AppleEvent; sendMode: AESendMode; sendPriority: AESendPriority; timeOutInTicks: LONGINT; idleProc: AEIdleUPP; filterProc: AEFilterUPP; refCon: LONGINT; userRoutine: OSASendUPP): OSErr;
  167.     {$IFC NOT GENERATINGCFM}
  168.     INLINE $205F, $4E90;
  169.     {$ENDC}
  170. {
  171. *************************************************************************
  172.     Standard Script Errors
  173. **************************************************************************
  174.     It is recommended that scripting components use the following set of error
  175.     codes to signal failure when applicable.  This enables applications that
  176.     use the OSA API to deal with some class of script errors in a less than 
  177.     ad hoc manner.  Scripting components are of course encouraged to return
  178.     component-specific errors when these don't apply.
  179. *************************************************************************
  180. }
  181. {
  182.         Dynamic errors:
  183.  
  184.     These errors result from data-dependent conditions and are typically
  185.     signaled at runtime.
  186. }
  187. {
  188.         Signaled when a value can't be coerced to the desired type. Similar
  189.           to errOSATypeError except results from coercion.
  190. }
  191.  
  192. CONST
  193.     errOSACantCoerce            = -1700;
  194.  
  195. {  Signaled when an object is not found in a container  }
  196.     errOSACantAccess            = -1728;
  197.  
  198. {
  199.         Signaled when an object cannot be set in a container.  Same as 
  200.           AERegistry error errAEWriteDenied.
  201. }
  202.     errOSACantAssign            = -10006;
  203.  
  204. {
  205.         Signaled by user scripts or applications when no actual error code
  206.           is to be returned.  Simply means "an error has occurred".  Most useful
  207.           in conjunction with an error message from the application.
  208. }
  209.     errOSAGeneralError            = -2700;
  210.  
  211. {  Signaled when there is an attempt to divide by zero  }
  212.     errOSADivideByZero            = -2701;
  213.  
  214. {  Signaled when integer or real value is too large to be represented  }
  215.     errOSANumericOverflow        = -2702;
  216.  
  217. {
  218.         Signaled when application can't be launched or when it is remote and
  219.           program linking is not enabled.
  220. }
  221.     errOSACantLaunch            = -2703;
  222.  
  223. {  Signaled when an application can't respond to AppleEvents  }
  224.     errOSAAppNotHighLevelEventAware = -2704;
  225.  
  226. {  Signaled when an application's terminology resource is not readable  }
  227.     errOSACorruptTerminology    = -2705;
  228.  
  229. {  Signaled when the runtime stack overflows  }
  230.     errOSAStackOverflow            = -2706;
  231.  
  232. {  Signaled when a runtime internal data structure overflows  }
  233.     errOSAInternalTableOverflow    = -2707;
  234.  
  235. {
  236.         Signaled when an intrinsic limitation is exceeded for the size of 
  237.           a value or data structure.
  238. }
  239.     errOSADataBlockTooLarge        = -2708;
  240.  
  241.     errOSACantGetTerminology    = -2709;
  242.  
  243.     errOSACantCreate            = -2710;
  244.  
  245. {
  246.         Component-specific dynamic script errors:
  247.  
  248.     The range -2720 thru -2739 is reserved for component-specific runtime errors.
  249.     (Note that error codes from different scripting components in this range will
  250.     overlap.)
  251. }
  252. {
  253.         Static errors:
  254.  
  255.     These errors comprise what are commonly thought of as parse and compile-
  256.     time errors.  However, in a dynamic system (e.g. AppleScript) any or all
  257.     of these may also occur at runtime.
  258. }
  259. {  Signaled when data was not the right type and coercion is not allowed  }
  260.     errOSATypeError                = -1703;
  261.  
  262. {  Signaled when a message was sent to an object that didn't handle it  }
  263.     OSAMessageNotUnderstood        = -1708;
  264.  
  265. {
  266.         Signaled when a function to be returned doesn't exist.  (Probably only
  267.           useful in languages with first-class functions that distinguish between
  268.           functions and other values (two name spaces). This is different from
  269.           errOSAMessageNotUnderstood, which may be signaled when the method is
  270.           invoked.
  271. }
  272.     OSAUndefinedHandler            = -1717;
  273.  
  274. {  Signaled when a container can never have the requested object  }
  275.     OSAIllegalAccess            = -1723;
  276.  
  277. {  Signaled when index was out of range. Specialization of errOSACantAccess.  }
  278.     OSAIllegalIndex                = -1719;
  279.  
  280. {  Signaled when a range is screwy. Specialization of errOSACantAccess.  }
  281.     OSAIllegalRange                = -1720;
  282.  
  283. {
  284.         Signaled when an object can never be set in a container.  Same as 
  285.           AERegistry error errAENotModifiable.
  286. }
  287.     OSAIllegalAssign            = -10003;
  288.  
  289. {
  290.         Signaled when a syntax error occurs. (e.g. "Syntax error" or
  291.          "<this> can't go after <that>").
  292. }
  293.     OSASyntaxError                = -2740;
  294.  
  295. {
  296.         Signaled when another form of syntax was expected. (e.g. "expected
  297.           a <type> but found <this>").
  298. }
  299.     OSASyntaxTypeError            = -2741;
  300.  
  301. {  Signaled when a name or number is too long to be parsed  }
  302.     OSATokenTooLong                = -2742;
  303.  
  304. {
  305.         Signaled when a parameter is missing for a function invocation.  Note
  306.           that in some languages, this error may occur at runtime.
  307. }
  308.     OSAMissingParameter            = -1701;
  309.  
  310. {
  311.         Signaled when function is called with the wrong number of parameters,
  312.           or a parameter pattern cannot be matched.
  313. }
  314.     OSAParameterMismatch        = -1721;
  315.  
  316. {
  317.         Signaled when a formal parameter, local variable, or instance variable
  318.           is specified more than once.
  319. }
  320.     OSADuplicateParameter        = -2750;
  321.  
  322. {
  323.         Signaled when a formal parameter, local variable, or instance variable
  324.           is specified more than once.
  325. }
  326.     OSADuplicateProperty        = -2751;
  327.  
  328. {
  329.         Signaled when more than one handler is defined with the same name in 
  330.           a scope where the language doesn't allow it.
  331. }
  332.     OSADuplicateHandler            = -2752;
  333.  
  334. {  Signaled when a variable is accessed that has no value  }
  335.     OSAUndefinedVariable        = -2753;
  336.  
  337. {
  338.         Signaled when a variable is declared inconsistently in the same scope,
  339.           such as both local and global.
  340. }
  341.     OSAInconsistentDeclarations    = -2754;
  342.  
  343. {
  344.         Signaled when illegal control flow occurs in an application (no catcher
  345.           for throw, non-lexical loop exit, etc.).
  346. }
  347.     OSAControlFlowError            = -2755;
  348.  
  349. {
  350.         Component-specific static script errors:
  351.  
  352.     The range -2760 thru -2779 is reserved for component-specific parsing and
  353.     compile-time errors. (Note that error codes from different scripting
  354.     components in this range will overlap.)
  355. }
  356. {
  357.         Dialect-specific script errors:
  358.  
  359.     The range -2780 thru -2799 is reserved for dialect specific error codes for
  360.     scripting components that support dialects. (Note that error codes from
  361.     different scripting components in this range will overlap, as well as error
  362.     codes from different dialects in the same scripting component.)
  363. }
  364. {
  365. *************************************************************************
  366.     OSA Interface Descriptions
  367. **************************************************************************
  368.     The OSA Interface is broken down into a required interface, and several
  369.     optional interfaces to support additional functionality.  A given scripting
  370.     component may choose to support only some of the optional interfaces in
  371.     addition to the basic interface.  The OSA Component Flags may be used to 
  372.     query the Component Manager to find a scripting component with a particular
  373.     capability, or determine if a particular scripting component supports a 
  374.     particular capability.
  375. *************************************************************************
  376. }
  377. {  OSA Component Flags:  }
  378.     kOSASupportsCompiling        = $0002;
  379.     kOSASupportsGetSource        = $0004;
  380.     kOSASupportsAECoercion        = $0008;
  381.     kOSASupportsAESending        = $0010;
  382.     kOSASupportsRecording        = $0020;
  383.     kOSASupportsConvenience        = $0040;
  384.     kOSASupportsDialects        = $0080;
  385.     kOSASupportsEventHandling    = $0100;
  386.  
  387. {  Component Selectors:  }
  388.     kOSASelectLoad                = $0001;
  389.     kOSASelectStore                = $0002;
  390.     kOSASelectExecute            = $0003;
  391.     kOSASelectDisplay            = $0004;
  392.     kOSASelectScriptError        = $0005;
  393.     kOSASelectDispose            = $0006;
  394.     kOSASelectSetScriptInfo        = $0007;
  395.     kOSASelectGetScriptInfo        = $0008;
  396.     kOSASelectSetActiveProc        = $0009;
  397.     kOSASelectGetActiveProc        = $000A;
  398.  
  399. {  Compiling:  }
  400.     kOSASelectScriptingComponentName = $0102;
  401.     kOSASelectCompile            = $0103;
  402.     kOSASelectCopyID            = $0104;
  403.  
  404. {  GetSource:  }
  405.     kOSASelectGetSource            = $0201;
  406.  
  407. {  AECoercion:  }
  408.     kOSASelectCoerceFromDesc    = $0301;
  409.     kOSASelectCoerceToDesc        = $0302;
  410.  
  411. {  AESending:  }
  412.     kOSASelectSetSendProc        = $0401;
  413.     kOSASelectGetSendProc        = $0402;
  414.     kOSASelectSetCreateProc        = $0403;
  415.     kOSASelectGetCreateProc        = $0404;
  416.     kOSASelectSetDefaultTarget    = $0405;
  417.  
  418. {  Recording:  }
  419.     kOSASelectStartRecording    = $0501;
  420.     kOSASelectStopRecording        = $0502;
  421.  
  422. {  Convenience:  }
  423.     kOSASelectLoadExecute        = $0601;
  424.     kOSASelectCompileExecute    = $0602;
  425.     kOSASelectDoScript            = $0603;
  426.  
  427. {  Dialects:  }
  428.     kOSASelectSetCurrentDialect    = $0701;
  429.     kOSASelectGetCurrentDialect    = $0702;
  430.     kOSASelectAvailableDialects    = $0703;
  431.     kOSASelectGetDialectInfo    = $0704;
  432.     kOSASelectAvailableDialectCodeList = $0705;
  433.  
  434. {  Event Handling:  }
  435.     kOSASelectSetResumeDispatchProc = $0801;
  436.     kOSASelectGetResumeDispatchProc = $0802;
  437.     kOSASelectExecuteEvent        = $0803;
  438.     kOSASelectDoEvent            = $0804;
  439.     kOSASelectMakeContext        = $0805;
  440.  
  441. {  scripting component specific selectors are added beginning with this value   }
  442.     kOSASelectComponentSpecificStart = $1001;
  443.  
  444. {
  445.         Mode Flags:
  446.  
  447.     Warning: These should not conflict with the AESend mode flags in
  448.     AppleEvents.h, because we may want to use them as OSA mode flags too.
  449. }
  450. {
  451.         This mode flag may be passed to OSALoad, OSAStore or OSACompile to
  452.           instruct the scripting component to not retain the "source" of an
  453.           expression.  This will cause the OSAGetSource call to return the error
  454.           errOSASourceNotAvailable if used.  However, some scripting components
  455.           may not retain the source anyway.  This is mainly used when either space
  456.           efficiency is desired, or a script is to be "locked" so that its
  457.           implementation may not be viewed.
  458. }
  459.     kOSAModePreventGetSource    = $00000001;
  460.  
  461. {
  462.         These mode flags may be passed to OSACompile, OSAExecute, OSALoadExecute
  463.           OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  464.           indicate whether or not the script may interact with the user, switch
  465.           layer or reconnect if necessary.  Any AppleEvents will be sent with the
  466.           corresponding AESend mode supplied.
  467. }
  468.     kOSAModeNeverInteract        = $00000010;
  469.     kOSAModeCanInteract            = $00000020;
  470.     kOSAModeAlwaysInteract        = $00000030;
  471.     kOSAModeDontReconnect        = $00000080;
  472.  
  473. {
  474.         This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  475.           OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  476.           indicate whether or not AppleEvents should be sent with the
  477.           kAECanSwitchLayer mode flag sent or not. NOTE: This flag is exactly the
  478.           opposite sense of the AppleEvent flag kAECanSwitchLayer.  This is to
  479.           provide a more convenient default, i.e. not supplying any mode
  480.           (kOSAModeNull) means to send events with kAECanSwitchLayer.  Supplying
  481.           the kOSAModeCantSwitchLayer mode flag will cause AESend to be called
  482.           without kAECanSwitchLayer.
  483. }
  484.     kOSAModeCantSwitchLayer        = $00000040;
  485.  
  486. {
  487.         This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  488.           OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  489.           indicate whether or not AppleEvents should be sent with the kAEDontRecord
  490.           mode flag sent or not. NOTE: This flag is exactly the opposite sense of
  491.           the AppleEvent flag kAEDontRecord.  This is to provide a more convenient
  492.           default, i.e. not supplying any mode (kOSAModeNull) means to send events
  493.           with kAEDontRecord.  Supplying the kOSAModeDoRecord mode flag will 
  494.           cause AESend to be called without kAEDontRecord.
  495. }
  496.     kOSAModeDoRecord            = $00001000;
  497.  
  498. {
  499.         This is a mode flag for OSACompile that indicates that a context should
  500.           be created as the result of compilation. All handler definitions are
  501.           inserted into the new context, and variables are initialized by
  502.           evaluating their initial values in a null context (i.e. they must be
  503.           constant expressions).
  504. }
  505.     kOSAModeCompileIntoContext    = $00000002;
  506.  
  507. {
  508.         This is a mode flag for OSACompile that indicates that the previous
  509.           script ID (input to OSACompile) should be augmented with any new
  510.           definitions in the sourceData rather than replaced with a new script.
  511.           This means that the previous script ID must designate a context.
  512.           The presence of this flag causes the kOSAModeCompileIntoContext flag
  513.           to be implicitly used, causing any new definitions to be initialized
  514.           in a null context.
  515. }
  516.     kOSAModeAugmentContext        = $00000004;
  517.  
  518. {
  519.         This mode flag may be passed to OSADisplay or OSADoScript to indicate
  520.           that output only need be human-readable, not re-compilable by OSACompile.
  521.           If used, output may be arbitrarily "beautified", e.g. quotes may be left
  522.           off of string values, long lists may have elipses, etc.
  523. }
  524.     kOSAModeDisplayForHumans    = $00000008;
  525.  
  526. {
  527.         This mode flag may be passed to OSAStore in the case where the scriptID
  528.           is a context.  This causes the context to be saved, but not the context's
  529.           parent context.  When the stored context is loaded back in, the parent
  530.           will be kOSANullScript.
  531. }
  532.     kOSAModeDontStoreParent        = $00010000;
  533.  
  534. {
  535.         This mode flag may be passed to OSAExecuteEvent to cause the event to
  536.           be dispatched to the direct object of the event. The direct object (or
  537.           subject attribute if the direct object is a non-object specifier) will
  538.           be resolved, and the resulting script object will be the recipient of
  539.           the message. The context argument to OSAExecuteEvent will serve as the
  540.           root of the lookup/resolution process.
  541. }
  542.     kOSAModeDispatchToDirectObject = $00020000;
  543.  
  544. {
  545.         This mode flag may be passed to OSAExecuteEvent to indicate that
  546.           components do not have to get the data of object specifier arguments.
  547. }
  548.     kOSAModeDontGetDataForArguments = $00040000;
  549.  
  550. {
  551. *************************************************************************
  552.     OSA Basic Scripting Interface
  553. **************************************************************************
  554.     Scripting components must at least support the Basic Scripting interface.
  555. *************************************************************************
  556. }
  557. {
  558.         Loading and Storing Scripts:
  559.  
  560.     These routines allow scripts to be loaded and stored in their internal
  561.     (possibly compiled, non-text) representation.
  562. }
  563. {  Resource type for scripts  }
  564.     kOSAScriptResourceType        = 'scpt';
  565.  
  566. {
  567.         Default type given to OSAStore which creates "generic" loadable script
  568.           data descriptors.
  569. }
  570.     typeOSAGenericStorage        = 'scpt';
  571.  
  572. FUNCTION OSALoad(scriptingComponent: ComponentInstance; {CONST}VAR scriptData: AEDesc; modeFlags: LONGINT; VAR resultingScriptID: OSAID): OSAError;
  573.     {$IFC NOT GENERATINGCFM}
  574.     INLINE $2F3C, $000C, $0001, $7000, $A82A;
  575.     {$ENDC}
  576. {
  577.         OSAComponentFunctionInline(kOSASelectLoad, 12);
  578.     
  579.         Errors:
  580.             badComponentInstance        invalid scripting component instance
  581.             errOSASystemError
  582.             errOSABadStorageType:        scriptData not for this scripting component
  583.             errOSACorruptData:            data seems to be corrupt
  584.             errOSADataFormatObsolete    script data format is no longer supported
  585.             errOSADataFormatTooNew        script data format is from a newer version
  586.         
  587.         ModeFlags:
  588.             kOSAModePreventGetSource
  589. }
  590. FUNCTION OSAStore(scriptingComponent: ComponentInstance; scriptID: OSAID; desiredType: DescType; modeFlags: LONGINT; VAR resultingScriptData: AEDesc): OSAError;
  591.     {$IFC NOT GENERATINGCFM}
  592.     INLINE $2F3C, $0010, $0002, $7000, $A82A;
  593.     {$ENDC}
  594. {
  595.         OSAComponentFunctionInline(kOSASelectStore, 16);
  596.     
  597.         Errors:
  598.             badComponentInstance    invalid scripting component instance
  599.             errOSASystemError
  600.             errOSAInvalidID
  601.             errOSABadStorageType:    desiredType not for this scripting component
  602.         
  603.         ModeFlags:
  604.             kOSAModePreventGetSource
  605.             kOSAModeDontStoreParent
  606. }
  607. {  Executing Scripts:  }
  608. FUNCTION OSAExecute(scriptingComponent: ComponentInstance; compiledScriptID: OSAID; contextID: OSAID; modeFlags: LONGINT; VAR resultingScriptValueID: OSAID): OSAError;
  609.     {$IFC NOT GENERATINGCFM}
  610.     INLINE $2F3C, $0010, $0003, $7000, $A82A;
  611.     {$ENDC}
  612. {
  613.         OSAComponentFunctionInline(kOSASelectExecute, 16);
  614.         This call runs a script.  The contextID represents the environment
  615.         with which global variables in the script are resolved.  The constant
  616.         kOSANullScript may be used for the contextID if the application wishes
  617.         to not deal with context directly (a default one is associated with each
  618.         scripting component instance).  The resultingScriptValueID is the 
  619.         result of evaluation, and contains a value which may be displayed using
  620.         the OSAGetSource call.  The modeFlags convey scripting component
  621.         specific information.
  622.     
  623.         Errors:
  624.             badComponentInstance    invalid scripting component instance
  625.             errOSASystemError
  626.             errOSAInvalidID
  627.             errOSAScriptError:        the executing script got an error
  628.     
  629.         ModeFlags:
  630.             kOSAModeNeverInteract
  631.             kOSAModeCanInteract
  632.             kOSAModeAlwaysInteract
  633.             kOSAModeCantSwitchLayer
  634.             kOSAModeDontReconnect
  635.             kOSAModeDoRecord
  636. }
  637. {  Displaying results:  }
  638. FUNCTION OSADisplay(scriptingComponent: ComponentInstance; scriptValueID: OSAID; desiredType: DescType; modeFlags: LONGINT; VAR resultingText: AEDesc): OSAError;
  639.     {$IFC NOT GENERATINGCFM}
  640.     INLINE $2F3C, $0010, $0004, $7000, $A82A;
  641.     {$ENDC}
  642. {
  643.         OSAComponentFunctionInline(kOSASelectDisplay, 16);
  644.         This call is used to convert results (script value IDs) into displayable
  645.         text. The desiredType should be at least typeChar, and modeFlags are
  646.         scripting system specific flags to control the formatting of the
  647.         resulting text. This call differs from OSAGetSource in that (1) it
  648.         always produces at least typeChar, (2) is only works on script values,
  649.         (3) it may display it's output in non-compilable form (e.g. without
  650.         string quotes, elipses inserted in long and/or circular lists, etc.) and
  651.         (4) it is required by the basic scripting interface.
  652.     
  653.         Errors:
  654.             badComponentInstance    invalid scripting component instance
  655.             errOSASystemError
  656.             errOSAInvalidID
  657.             errAECoercionFail:        desiredType not supported by scripting component
  658.     
  659.         ModeFlags:
  660.             kOSAModeDisplayForHumans
  661. }
  662. {  Getting Error Information:  }
  663. FUNCTION OSAScriptError(scriptingComponent: ComponentInstance; selector: OSType; desiredType: DescType; VAR resultingErrorDescription: AEDesc): OSAError;
  664.     {$IFC NOT GENERATINGCFM}
  665.     INLINE $2F3C, $000C, $0005, $7000, $A82A;
  666.     {$ENDC}
  667. {
  668.         OSAComponentFunctionInline(kOSASelectScriptError, 12);
  669.         Whenever script execution returns errOSAExecutionError, this routine
  670.         may be used to get information about that error.  The selector describes
  671.         the type of information desired about the error (various selectors are
  672.         listed below).  The desiredType indicates the data type of the result
  673.         desired for that selector.
  674.     
  675.         Errors:
  676.             badComponentInstance    invalid scripting component instance
  677.             errOSASystemError
  678.             errOSABadSelector:        selector not supported by scripting component
  679.             errAECoercionFail:        desiredType not supported by scripting component
  680. }
  681. {  OSAScriptError selectors:  }
  682. {
  683.         This selector is used to determine the error number of a script error.
  684.         These error numbers may be either system error numbers, or error numbers
  685.         that are scripting component specific.
  686.         Required desiredTypes:    
  687.               typeShortInteger
  688. }
  689.  
  690. CONST
  691.     kOSAErrorNumber                = 'errn';
  692.  
  693. {
  694.         This selector is used to determine the full error message associated
  695.         with the error number.  It should include the name of the application
  696.         which caused the error, as well as the specific error that occurred.
  697.         This selector is sufficient for simple error reporting (but see
  698.         kOSAErrorBriefMessage, below).
  699.         Required desiredTypes:
  700.             typeChar                    error message string
  701. }
  702.     kOSAErrorMessage            = 'errs';
  703.  
  704. {
  705.         This selector is used to determine a brief error message associated with
  706.         the error number.  This message and should not mention the name of the
  707.         application which caused the error, any partial results or offending
  708.         object (see kOSAErrorApp, kOSAErrorPartialResult and
  709.         kOSAErrorOffendingObject, below).
  710.         Required desiredTypes:
  711.               typeChar                    brief error message string
  712. }
  713. {   0x65727262   }
  714.     kOSAErrorBriefMessage        = 'errb';
  715.  
  716. {
  717.         This selector is used to determine which application actually got the
  718.         error (if it was the result of an AESend), or the current application
  719.         if ....
  720.         Required desiredTypes:
  721.               typeProcessSerialNumber        PSN of the errant application
  722.               typeChar                    name of the errant application
  723. }
  724. {   0x65726170   }
  725.     kOSAErrorApp                = 'erap';
  726.  
  727. {
  728.         This selector is used to determine any partial result returned by an 
  729.         operation. If an AESend call failed, but a partial result was returned,
  730.         then the partial result may be returned as an AEDesc.
  731.         Required desiredTypes:
  732.               typeBest                    AEDesc of any partial result
  733. }
  734. {   0x70746c72    }
  735.     kOSAErrorPartialResult        = 'ptlr';
  736.  
  737. {
  738.         This selector is used to determine any object which caused the error
  739.         that may have been indicated by an application.  The result is an 
  740.         AEDesc.
  741.         Required desiredTypes:
  742.               typeBest                    AEDesc of any offending object
  743. }
  744. {   0x65726f62    }
  745.     kOSAErrorOffendingObject    = 'erob';
  746.  
  747. {
  748.         This selector is used to determine the type expected by a coercion 
  749.         operation if a type error occurred.
  750. }
  751. {   0x65727274    }
  752.     kOSAErrorExpectedType        = 'errt';
  753.  
  754. {
  755.         This selector is used to determine the source text range (start and 
  756.         end positions) of where the error occurred.
  757.         Required desiredTypes:
  758.               typeOSAErrorRange
  759. }
  760. {   0x65726e67   }
  761.     kOSAErrorRange                = 'erng';
  762.  
  763. {
  764.         An AERecord type containing keyOSASourceStart and keyOSASourceEnd fields
  765.         of type short.
  766. }
  767. {   0x65726e67    }
  768.     typeOSAErrorRange            = 'erng';
  769.  
  770. {  Field of a typeOSAErrorRange record of typeShortInteger  }
  771. {   0x73726373     }
  772.     keyOSASourceStart            = 'srcs';
  773.  
  774. {  Field of a typeOSAErrorRange record of typeShortInteger  }
  775. {   0x73726365    }
  776.     keyOSASourceEnd                = 'srce';
  777.  
  778. {  Disposing Script IDs:  }
  779. FUNCTION OSADispose(scriptingComponent: ComponentInstance; scriptID: OSAID): OSAError;
  780.     {$IFC NOT GENERATINGCFM}
  781.     INLINE $2F3C, $0004, $0006, $7000, $A82A;
  782.     {$ENDC}
  783. {
  784.         OSAComponentFunctionInline(kOSASelectDispose, 4);
  785.         Disposes a script or context.
  786.     
  787.         Errors:
  788.             badComponentInstance    invalid scripting component instance
  789.             errOSASystemError
  790.             errOSAInvalidID
  791. }
  792. {  Getting and Setting Script Information:  }
  793. FUNCTION OSASetScriptInfo(scriptingComponent: ComponentInstance; scriptID: OSAID; selector: OSType; value: LONGINT): OSAError;
  794.     {$IFC NOT GENERATINGCFM}
  795.     INLINE $2F3C, $000C, $0007, $7000, $A82A;
  796.     {$ENDC}
  797. {
  798.         OSAComponentFunctionInline(kOSASelectSetScriptInfo, 12);
  799.     
  800.         Errors:
  801.             badComponentInstance    invalid scripting component instance
  802.             errOSASystemError
  803.             errOSAInvalidID
  804.             errOSABadSelector:        selector not supported by scripting component
  805.                                     or selector not for this scriptID
  806. }
  807. FUNCTION OSAGetScriptInfo(scriptingComponent: ComponentInstance; scriptID: OSAID; selector: OSType; VAR result: LONGINT): OSAError;
  808.     {$IFC NOT GENERATINGCFM}
  809.     INLINE $2F3C, $000C, $0008, $7000, $A82A;
  810.     {$ENDC}
  811. {
  812.         OSAComponentFunctionInline(kOSASelectGetScriptInfo, 12);
  813.     
  814.         Errors:
  815.             badComponentInstance    invalid scripting component instance
  816.             errOSASystemError
  817.             errOSAInvalidID
  818.             errOSABadSelector:        selector not supported by scripting component
  819.                                     or selector not for this scriptID
  820. }
  821. {
  822.  Manipulating the ActiveProc:
  823.  
  824.     Scripting systems will supply default values for these procedures if they
  825.     are not set by the client:
  826. }
  827.  
  828. TYPE
  829.     OSAActiveProcPtr = ProcPtr;  { FUNCTION OSAActive(refCon: LONGINT): OSErr; }
  830.  
  831.     OSAActiveUPP = UniversalProcPtr;
  832.  
  833. CONST
  834.     uppOSAActiveProcInfo = $000000E0;
  835.  
  836. FUNCTION NewOSAActiveProc(userRoutine: OSAActiveProcPtr): OSAActiveUPP;
  837.     {$IFC NOT GENERATINGCFM }
  838.     INLINE $2E9F;
  839.     {$ENDC}
  840.  
  841. FUNCTION CallOSAActiveProc(refCon: LONGINT; userRoutine: OSAActiveUPP): OSErr;
  842.     {$IFC NOT GENERATINGCFM}
  843.     INLINE $205F, $4E90;
  844.     {$ENDC}
  845. FUNCTION OSASetActiveProc(scriptingComponent: ComponentInstance; activeProc: OSAActiveUPP; refCon: LONGINT): OSAError;
  846.     {$IFC NOT GENERATINGCFM}
  847.     INLINE $2F3C, $0008, $0009, $7000, $A82A;
  848.     {$ENDC}
  849. {
  850.         OSAComponentFunctionInline(kOSASelectSetActiveProc, 8);
  851.         If activeProc is nil, the default activeProc is used.
  852.     
  853.         Errors:
  854.             badComponentInstance    invalid scripting component instance
  855.             errOSASystemError
  856. }
  857. FUNCTION OSAGetActiveProc(scriptingComponent: ComponentInstance; VAR activeProc: OSAActiveUPP; VAR refCon: LONGINT): OSAError;
  858.     {$IFC NOT GENERATINGCFM}
  859.     INLINE $2F3C, $0008, $000A, $7000, $A82A;
  860.     {$ENDC}
  861. {
  862.         OSAComponentFunctionInline(kOSASelectGetActiveProc, 8);
  863.     
  864.         Errors:
  865.             badComponentInstance    invalid scripting component instance
  866.             errOSASystemError
  867. }
  868. {
  869. *************************************************************************
  870.     OSA Optional Compiling Interface
  871. **************************************************************************
  872.     Scripting components that support the Compiling interface have the 
  873.     kOSASupportsCompiling bit set in it's ComponentDescription.
  874. *************************************************************************
  875. }
  876. FUNCTION OSAScriptingComponentName(scriptingComponent: ComponentInstance; VAR resultingScriptingComponentName: AEDesc): OSAError;
  877.     {$IFC NOT GENERATINGCFM}
  878.     INLINE $2F3C, $0004, $0102, $7000, $A82A;
  879.     {$ENDC}
  880. {
  881.         OSAComponentFunctionInline(kOSASelectScriptingComponentName, 4);
  882.         Given a scripting component, this routine returns the name of that
  883.         scripting component in a type that is coercable to text (typeChar).
  884.         The generic scripting component returns the name of the default
  885.         scripting component.  This name should be sufficient to convey to the
  886.         user the kind of script (syntax) he is expected to write.
  887.     
  888.         Errors:
  889.             badComponentInstance    invalid scripting component instance
  890.             errOSASystemError
  891. }
  892. FUNCTION OSACompile(scriptingComponent: ComponentInstance; {CONST}VAR sourceData: AEDesc; modeFlags: LONGINT; VAR previousAndResultingScriptID: OSAID): OSAError;
  893.     {$IFC NOT GENERATINGCFM}
  894.     INLINE $2F3C, $000C, $0103, $7000, $A82A;
  895.     {$ENDC}
  896. {
  897.         OSAComponentFunctionInline(kOSASelectCompile, 12);
  898.         Coerces input desc (possibly text) into a script's internal format.
  899.         Once compiled, the script is ready to run.  The modeFlags convey
  900.         scripting component specific information.  The previous script ID
  901.         (result parameter) is made to refer to the newly compiled script,
  902.         unless it was originally kOSANullScript.  In this case a new script
  903.         ID is created and used.
  904.     
  905.         Errors:
  906.             badComponentInstance    invalid scripting component instance
  907.             errOSASystemError
  908.             errAECoercionFail:        sourceData is not compilable
  909.             errOSAScriptError:        sourceData was a bad script (syntax error)
  910.             errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  911.                                     valid on input
  912.     
  913.         ModeFlags:
  914.             kOSAModePreventGetSource
  915.             kOSAModeCompileIntoContext
  916.             kOSAModeAugmentContext
  917.             kOSAModeNeverInteract
  918.             kOSAModeCanInteract
  919.             kOSAModeAlwaysInteract
  920.             kOSAModeCantSwitchLayer
  921.             kOSAModeDontReconnect
  922.             kOSAModeDoRecord
  923. }
  924. FUNCTION OSACopyID(scriptingComponent: ComponentInstance; fromID: OSAID; VAR toID: OSAID): OSAError;
  925.     {$IFC NOT GENERATINGCFM}
  926.     INLINE $2F3C, $0008, $0104, $7000, $A82A;
  927.     {$ENDC}
  928. {
  929.         OSAComponentFunctionInline(kOSASelectCopyID, 8);
  930.         If toID is a reference to kOSANullScript then it is updated to have a
  931.         new scriptID value.  This call can be used to perform undo or revert
  932.         operations on scripts. 
  933.     
  934.         Errors:
  935.             badComponentInstance    invalid scripting component instance
  936.             errOSASystemError
  937.             errOSAInvalidID
  938. }
  939. {
  940. *************************************************************************
  941.     OSA Optional GetSource Interface
  942. **************************************************************************
  943.     Scripting components that support the GetSource interface have the 
  944.     kOSASupportsGetSource bit set in it's ComponentDescription.
  945. *************************************************************************
  946. }
  947. FUNCTION OSAGetSource(scriptingComponent: ComponentInstance; scriptID: OSAID; desiredType: DescType; VAR resultingSourceData: AEDesc): OSAError;
  948.     {$IFC NOT GENERATINGCFM}
  949.     INLINE $2F3C, $000C, $0201, $7000, $A82A;
  950.     {$ENDC}
  951. {
  952.         OSAComponentFunctionInline(kOSASelectGetSource, 12);
  953.         This routine causes a compiled script to be output in a form (possibly
  954.         text) such that it is suitable to be passed back to OSACompile.
  955.  
  956.         Errors:
  957.             badComponentInstance    invalid scripting component instance
  958.             errOSASystemError
  959.             errOSAInvalidID
  960.             errOSASourceNotAvailable    can't get source for this scriptID
  961. }
  962. {
  963. *************************************************************************
  964.     OSA Optional AECoercion Interface
  965. **************************************************************************
  966.     Scripting components that support the AECoercion interface have the 
  967.     kOSASupportsAECoercion bit set in it's ComponentDescription.
  968. *************************************************************************
  969. }
  970. FUNCTION OSACoerceFromDesc(scriptingComponent: ComponentInstance; {CONST}VAR scriptData: AEDesc; modeFlags: LONGINT; VAR resultingScriptID: OSAID): OSAError;
  971.     {$IFC NOT GENERATINGCFM}
  972.     INLINE $2F3C, $000C, $0301, $7000, $A82A;
  973.     {$ENDC}
  974. {
  975.         OSAComponentFunctionInline(kOSASelectCoerceFromDesc, 12);
  976.         This routine causes script data to be coerced into a script value.
  977.         If the scriptData is an AppleEvent, then the resultingScriptID is a
  978.         compiled script ID (mode flags for OSACompile may be used in this case).
  979.         Other scriptData descriptors create script value IDs.
  980.     
  981.         Errors:
  982.             badComponentInstance    invalid scripting component instance
  983.             errOSASystemError
  984.     
  985.         ModeFlags:
  986.             kOSAModePreventGetSource
  987.             kOSAModeCompileIntoContext
  988.             kOSAModeNeverInteract
  989.             kOSAModeCanInteract
  990.             kOSAModeAlwaysInteract
  991.             kOSAModeCantSwitchLayer
  992.             kOSAModeDontReconnect
  993.             kOSAModeDoRecord
  994. }
  995. FUNCTION OSACoerceToDesc(scriptingComponent: ComponentInstance; scriptID: OSAID; desiredType: DescType; modeFlags: LONGINT; VAR result: AEDesc): OSAError;
  996.     {$IFC NOT GENERATINGCFM}
  997.     INLINE $2F3C, $0010, $0302, $7000, $A82A;
  998.     {$ENDC}
  999. {
  1000.         OSAComponentFunctionInline(kOSASelectCoerceToDesc, 16);
  1001.         This routine causes a script value to be coerced into any desired form.
  1002.         If the scriptID denotes a compiled script, then it may be coerced to 
  1003.         typeAppleEvent.
  1004.     
  1005.         Errors:
  1006.             badComponentInstance    invalid scripting component instance
  1007.             errOSASystemError
  1008.             errOSAInvalidID
  1009. }
  1010. {
  1011. *************************************************************************
  1012.     OSA Optional AESending Interface
  1013. **************************************************************************
  1014.     Scripting components that support the AESending interface have the 
  1015.     kOSASupportsAESending bit set in it's ComponentDescription.
  1016. *************************************************************************
  1017. }
  1018. {
  1019.     Scripting systems will supply default values for these procedures if they
  1020.     are not set by the client:
  1021. }
  1022. FUNCTION OSASetSendProc(scriptingComponent: ComponentInstance; sendProc: OSASendUPP; refCon: LONGINT): OSAError;
  1023.     {$IFC NOT GENERATINGCFM}
  1024.     INLINE $2F3C, $0008, $0401, $7000, $A82A;
  1025.     {$ENDC}
  1026. {
  1027.         OSAComponentFunctionInline(kOSASelectSetSendProc, 8);
  1028.         If sendProc is nil, the default sendProc is used.
  1029.     
  1030.         Errors:
  1031.             badComponentInstance    invalid scripting component instance
  1032.             errOSASystemError
  1033. }
  1034. FUNCTION OSAGetSendProc(scriptingComponent: ComponentInstance; VAR sendProc: OSASendUPP; VAR refCon: LONGINT): OSAError;
  1035.     {$IFC NOT GENERATINGCFM}
  1036.     INLINE $2F3C, $0008, $0402, $7000, $A82A;
  1037.     {$ENDC}
  1038. {
  1039.         OSAComponentFunctionInline(kOSASelectGetSendProc, 8);
  1040.     
  1041.         Errors:
  1042.             badComponentInstance    invalid scripting component instance
  1043.             errOSASystemError
  1044. }
  1045. FUNCTION OSASetCreateProc(scriptingComponent: ComponentInstance; createProc: OSACreateAppleEventUPP; refCon: LONGINT): OSAError;
  1046.     {$IFC NOT GENERATINGCFM}
  1047.     INLINE $2F3C, $0008, $0403, $7000, $A82A;
  1048.     {$ENDC}
  1049. {
  1050.         OSAComponentFunctionInline(kOSASelectSetCreateProc, 8);
  1051.         If createProc is nil, the default createProc is used.
  1052.     
  1053.         Errors:
  1054.             badComponentInstance    invalid scripting component instance
  1055.             errOSASystemError
  1056. }
  1057. FUNCTION OSAGetCreateProc(scriptingComponent: ComponentInstance; VAR createProc: OSACreateAppleEventUPP; VAR refCon: LONGINT): OSAError;
  1058.     {$IFC NOT GENERATINGCFM}
  1059.     INLINE $2F3C, $0008, $0404, $7000, $A82A;
  1060.     {$ENDC}
  1061. {
  1062.         OSAComponentFunctionInline(kOSASelectGetCreateProc, 8);
  1063.     
  1064.         Errors:
  1065.             badComponentInstance    invalid scripting component instance
  1066.             errOSASystemError
  1067. }
  1068. FUNCTION OSASetDefaultTarget(scriptingComponent: ComponentInstance; {CONST}VAR target: AEAddressDesc): OSAError;
  1069.     {$IFC NOT GENERATINGCFM}
  1070.     INLINE $2F3C, $0004, $0405, $7000, $A82A;
  1071.     {$ENDC}
  1072. {
  1073.         OSAComponentFunctionInline(kOSASelectSetDefaultTarget, 4);
  1074.         This routine sets the default target application for AE sending.
  1075.         It also establishes the default target from which terminologies come.
  1076.         It is effectively like having an AppleScript "tell" statement around
  1077.         the entire program.  If this routine is not called, or if the target 
  1078.         is a null AEDesc, then the current application is the default target.
  1079.     
  1080.         Errors:
  1081.             badComponentInstance    invalid scripting component instance
  1082.             errOSASystemError
  1083. }
  1084. {
  1085. *************************************************************************
  1086.     OSA Optional Recording Interface
  1087. **************************************************************************
  1088.     Scripting components that support the Recording interface have the 
  1089.     kOSASupportsRecording bit set in it's ComponentDescription.
  1090. *************************************************************************
  1091. }
  1092. FUNCTION OSAStartRecording(scriptingComponent: ComponentInstance; VAR compiledScriptToModifyID: OSAID): OSAError;
  1093.     {$IFC NOT GENERATINGCFM}
  1094.     INLINE $2F3C, $0004, $0501, $7000, $A82A;
  1095.     {$ENDC}
  1096. {
  1097.         OSAComponentFunctionInline(kOSASelectStartRecording, 4);
  1098.         Starts recording.  If compiledScriptToModifyID is kOSANullScript, a
  1099.         new script ID is created and returned.  If the current application has
  1100.         a handler for the kOSARecordedText event, then kOSARecordedText events
  1101.         are sent to the application containing the text of each AppleEvent 
  1102.         recorded.
  1103.     
  1104.         Errors:
  1105.             badComponentInstance    invalid scripting component instance
  1106.             errOSASystemError
  1107.             errOSAInvalidID
  1108.             errOSARecordingIsAlreadyOn
  1109. }
  1110. FUNCTION OSAStopRecording(scriptingComponent: ComponentInstance; compiledScriptID: OSAID): OSAError;
  1111.     {$IFC NOT GENERATINGCFM}
  1112.     INLINE $2F3C, $0004, $0502, $7000, $A82A;
  1113.     {$ENDC}
  1114. {
  1115.         OSAComponentFunctionInline(kOSASelectStopRecording, 4);
  1116.         If compiledScriptID is not being recorded into or recording is not
  1117.         currently on, no error is returned.
  1118.     
  1119.         Errors:
  1120.             badComponentInstance    invalid scripting component instance
  1121.             errOSASystemError
  1122.             errOSAInvalidID
  1123. }
  1124. {
  1125. *************************************************************************
  1126.     OSA Optional Convenience Interface
  1127. **************************************************************************
  1128.     Scripting components that support the Convenience interface have the 
  1129.     kOSASupportsConvenience bit set in it's ComponentDescription.
  1130. *************************************************************************
  1131. }
  1132. FUNCTION OSALoadExecute(scriptingComponent: ComponentInstance; {CONST}VAR scriptData: AEDesc; contextID: OSAID; modeFlags: LONGINT; VAR resultingScriptValueID: OSAID): OSAError;
  1133.     {$IFC NOT GENERATINGCFM}
  1134.     INLINE $2F3C, $0010, $0601, $7000, $A82A;
  1135.     {$ENDC}
  1136. {
  1137.         OSAComponentFunctionInline(kOSASelectLoadExecute, 16);
  1138.         This routine is effectively equivalent to calling OSALoad followed by
  1139.         OSAExecute.  After execution, the compiled source is disposed.  Only the
  1140.         resulting value ID is retained.
  1141.     
  1142.         Errors:
  1143.             badComponentInstance        invalid scripting component instance
  1144.             errOSASystemError
  1145.             errOSABadStorageType:        scriptData not for this scripting component
  1146.             errOSACorruptData:            data seems to be corrupt
  1147.             errOSADataFormatObsolete    script data format is no longer supported
  1148.             errOSADataFormatTooNew        script data format is from a newer version
  1149.             errOSAInvalidID
  1150.             errOSAScriptError:            the executing script got an error
  1151.     
  1152.         ModeFlags:
  1153.             kOSAModeNeverInteract
  1154.             kOSAModeCanInteract
  1155.             kOSAModeAlwaysInteract
  1156.             kOSAModeCantSwitchLayer
  1157.             kOSAModeDontReconnect
  1158.             kOSAModeDoRecord
  1159. }
  1160. FUNCTION OSACompileExecute(scriptingComponent: ComponentInstance; {CONST}VAR sourceData: AEDesc; contextID: OSAID; modeFlags: LONGINT; VAR resultingScriptValueID: OSAID): OSAError;
  1161.     {$IFC NOT GENERATINGCFM}
  1162.     INLINE $2F3C, $0010, $0602, $7000, $A82A;
  1163.     {$ENDC}
  1164. {
  1165.         OSAComponentFunctionInline(kOSASelectCompileExecute, 16);
  1166.         This routine is effectively equivalent to calling OSACompile followed by
  1167.         OSAExecute.  After execution, the compiled source is disposed.  Only the
  1168.         resulting value ID is retained.
  1169.     
  1170.         Errors:
  1171.             badComponentInstance    invalid scripting component instance
  1172.             errOSASystemError
  1173.             errAECoercionFail:        sourceData is not compilable
  1174.             errOSAScriptError:        sourceData was a bad script (syntax error)
  1175.             errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1176.                                     valid on input
  1177.             errOSAScriptError:        the executing script got an error
  1178.     
  1179.         ModeFlags:
  1180.             kOSAModeNeverInteract
  1181.             kOSAModeCanInteract
  1182.             kOSAModeAlwaysInteract
  1183.             kOSAModeCantSwitchLayer
  1184.             kOSAModeDontReconnect
  1185.             kOSAModeDoRecord
  1186. }
  1187. FUNCTION OSADoScript(scriptingComponent: ComponentInstance; {CONST}VAR sourceData: AEDesc; contextID: OSAID; desiredType: DescType; modeFlags: LONGINT; VAR resultingText: AEDesc): OSAError;
  1188.     {$IFC NOT GENERATINGCFM}
  1189.     INLINE $2F3C, $0014, $0603, $7000, $A82A;
  1190.     {$ENDC}
  1191. {
  1192.         OSAComponentFunctionInline(kOSASelectDoScript, 20);
  1193.         This routine is effectively equivalent to calling OSACompile followed by
  1194.         OSAExecute and then OSADisplay.  After execution, the compiled source
  1195.         and the resulting value are is disposed.  Only the resultingText
  1196.         descriptor is retained.  If a script error occur during processing, the 
  1197.         resultingText gets the error message of the error, and errOSAScriptError
  1198.         is returned.  OSAScriptError may still be used to extract more 
  1199.         information about the particular error.
  1200.     
  1201.         Errors:
  1202.             badComponentInstance    invalid scripting component instance
  1203.             errOSASystemError
  1204.             errAECoercionFail:        sourceData is not compilable or 
  1205.                                     desiredType not supported by scripting component
  1206.             errOSAScriptError:        sourceData was a bad script (syntax error)
  1207.             errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1208.                                     valid on input
  1209.             errOSAScriptError:        the executing script got an error
  1210.     
  1211.         ModeFlags:
  1212.             kOSAModeNeverInteract
  1213.             kOSAModeCanInteract
  1214.             kOSAModeAlwaysInteract
  1215.             kOSAModeCantSwitchLayer
  1216.             kOSAModeDontReconnect
  1217.             kOSAModeDoRecord
  1218.             kOSAModeDisplayForHumans
  1219. }
  1220. {
  1221. *************************************************************************
  1222.     OSA Optional Dialects Interface
  1223. **************************************************************************
  1224.     Scripting components that support the Dialects interface have the 
  1225.     kOSASupportsDialects bit set in it's ComponentDescription.
  1226. *************************************************************************
  1227. }
  1228. {
  1229.     These calls allows an scripting component that supports different dialects
  1230.     to dynamically switch between those dialects.  Although this interface is
  1231.     specified, the particular dialect codes are scripting component dependent.
  1232. }
  1233. FUNCTION OSASetCurrentDialect(scriptingComponent: ComponentInstance; dialectCode: INTEGER): OSAError;
  1234.     {$IFC NOT GENERATINGCFM}
  1235.     INLINE $2F3C, $0002, $0701, $7000, $A82A;
  1236.     {$ENDC}
  1237. {
  1238.         OSAComponentFunctionInline(kOSASelectSetCurrentDialect, 2);
  1239.     
  1240.         Errors:
  1241.             badComponentInstance    invalid scripting component instance
  1242.             errOSASystemError
  1243.             errOSANoSuchDialect:    invalid dialectCode
  1244. }
  1245. FUNCTION OSAGetCurrentDialect(scriptingComponent: ComponentInstance; VAR resultingDialectCode: INTEGER): OSAError;
  1246.     {$IFC NOT GENERATINGCFM}
  1247.     INLINE $2F3C, $0004, $0702, $7000, $A82A;
  1248.     {$ENDC}
  1249. {
  1250.         OSAComponentFunctionInline(kOSASelectGetCurrentDialect, 4);
  1251.     
  1252.         Errors:
  1253.             badComponentInstance    invalid scripting component instance
  1254.             errOSASystemError
  1255. }
  1256. FUNCTION OSAAvailableDialects(scriptingComponent: ComponentInstance; VAR resultingDialectInfoList: AEDesc): OSAError;
  1257.     {$IFC NOT GENERATINGCFM}
  1258.     INLINE $2F3C, $0004, $0703, $7000, $A82A;
  1259.     {$ENDC}
  1260. {
  1261.         OSAComponentFunctionInline(kOSASelectAvailableDialects, 4);
  1262.         This call return an AEList containing information about each of the
  1263.         currently available dialects of a scripting component.  Each item
  1264.         is an AERecord of typeOSADialectInfo that contains at least the fields
  1265.         keyOSADialectName, keyOSADialectCode, KeyOSADialectLangCode and 
  1266.         keyOSADialectScriptCode.
  1267.     
  1268.         Errors:
  1269.             badComponentInstance    invalid scripting component instance
  1270.             errOSASystemError
  1271. }
  1272. FUNCTION OSAGetDialectInfo(scriptingComponent: ComponentInstance; dialectCode: INTEGER; selector: OSType; VAR resultingDialectInfo: AEDesc): OSAError;
  1273.     {$IFC NOT GENERATINGCFM}
  1274.     INLINE $2F3C, $000A, $0704, $7000, $A82A;
  1275.     {$ENDC}
  1276. {
  1277.         OSAComponentFunctionInline(kOSASelectGetDialectInfo, 10);
  1278.         This call gives information about the specified dialect of a scripting
  1279.         component. It returns an AEDesc whose type depends on the selector 
  1280.         specified. Available selectors are the same as the field keys for a
  1281.         dialect info record. The type of AEDesc returned is the same as the 
  1282.         type of the field that has same key as the selector.
  1283.     
  1284.         Errors:
  1285.             badComponentInstance    invalid scripting component instance
  1286.             errOSASystemError
  1287.              errOSABadSelector
  1288.             errOSANoSuchDialect:    invalid dialectCode
  1289. }
  1290. FUNCTION OSAAvailableDialectCodeList(scriptingComponent: ComponentInstance; VAR resultingDialectCodeList: AEDesc): OSAError;
  1291.     {$IFC NOT GENERATINGCFM}
  1292.     INLINE $2F3C, $0004, $0705, $7000, $A82A;
  1293.     {$ENDC}
  1294. {
  1295.         OSAComponentFunctionInline(kOSASelectAvailableDialectCodeList, 4);
  1296.         This is alternative to OSAGetAvailableDialectCodeList. Use this call
  1297.         and  OSAGetDialectInfo to get information on dialects.
  1298.         This call return an AEList containing dialect code for each of the
  1299.         currently available dialects of a scripting component. Each dialect
  1300.         code is a short integer of type typeShortInteger.
  1301.     
  1302.         Errors:
  1303.             badComponentInstance    invalid scripting component instance
  1304.             errOSASystemError
  1305.  
  1306.         Type of a dialect info record containing at least keyOSADialectName
  1307.         and keyOSADialectCode fields.
  1308.  
  1309.         keys for dialect info record, also used as selectors to OSAGetDialectInfo.
  1310.  
  1311.         Field of a typeOSADialectInfo record of typeChar.
  1312.         Field of a typeOSADialectInfo record of typeShortInteger.
  1313.         Field of a typeOSADialectInfo record of typeShortInteger.
  1314.         Field of a typeOSADialectInfo record of typeShortInteger.
  1315. }
  1316. {
  1317. *************************************************************************
  1318.     OSA Optional Event Handling Interface
  1319. **************************************************************************
  1320.     Scripting components that support the Event Handling interface have the 
  1321.     kOSASupportsEventHandling bit set in it's ComponentDescription.
  1322. *************************************************************************
  1323. }
  1324. FUNCTION OSASetResumeDispatchProc(scriptingComponent: ComponentInstance; resumeDispatchProc: AEEventHandlerUPP; refCon: LONGINT): OSAError;
  1325.     {$IFC NOT GENERATINGCFM}
  1326.     INLINE $2F3C, $0008, $0801, $7000, $A82A;
  1327.     {$ENDC}
  1328. {
  1329.         OSAComponentFunctionInline(kOSASelectSetResumeDispatchProc, 8);
  1330.         This function is used to set the ResumeDispatchProc that will be used
  1331.         by OSAExecuteEvent and OSADoEvent if either no event handler can be
  1332.         found in the context, or the context event hander "continues" control
  1333.         onward. The two constants kOSAUseStandardDispatch and kOSANoDispatch
  1334.         may also be passed to this routine indicating that the handler registered
  1335.         in the application with AEInstallEventHandler should be used, or no
  1336.         dispatch should occur, respectively.
  1337.     
  1338.         Errors:
  1339.             badComponentInstance    invalid scripting component instance
  1340.             errOSASystemError
  1341. }
  1342.  
  1343. CONST
  1344.     kOSAUseStandardDispatch        = $FFFFFFFF;
  1345.  
  1346. {
  1347.         Special ResumeDispatchProc constant which may be passed to 
  1348.         OSASetResumeDispatchProc indicating that the handler registered
  1349.         in the application with AEInstallEventHandler should be used.
  1350.         
  1351.         NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1352.                 doesn't allow pointer types to be assigned to an enum.  All
  1353.                 constants must be assigned as enums to translate properly to
  1354.                 Pascal.
  1355. }
  1356.     kOSANoDispatch                = 0;
  1357.  
  1358. {
  1359.         Special ResumeDispatchProc constant which may be passed to 
  1360.         OSASetResumeDispatchProc indicating that no dispatch should occur.
  1361.         
  1362.         NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1363.                 doesn't allow pointer types to be assigned to an enum.  All
  1364.                 constants must be assigned as enums to translate properly to
  1365.                 Pascal.
  1366. }
  1367.     kOSADontUsePhac                = $0001;
  1368.  
  1369. {
  1370.         Special refCon constant that may be given to OSASetResumeDispatchProc
  1371.         only when kOSAUseStandardDispatch is used as the ResumeDispatchProc.
  1372.         This causes the standard dispatch to be performed, except the phac
  1373.         handler is not called.  This is useful during tinkerability, when
  1374.         the phac handler is used to lookup a context associated with an event's 
  1375.         direct parameter, and call OSAExecuteEvent or OSADoEvent.  Failure to
  1376.         bypass the phac handler would result in an infinite loop.
  1377. }
  1378. FUNCTION OSAGetResumeDispatchProc(scriptingComponent: ComponentInstance; VAR resumeDispatchProc: AEEventHandlerUPP; VAR refCon: LONGINT): OSAError;
  1379.     {$IFC NOT GENERATINGCFM}
  1380.     INLINE $2F3C, $0008, $0802, $7000, $A82A;
  1381.     {$ENDC}
  1382. {
  1383.         OSAComponentFunctionInline(kOSASelectGetResumeDispatchProc, 8);
  1384.         Returns the registered ResumeDispatchProc.  If no ResumeDispatchProc has
  1385.         been registered, then kOSAUseStandardDispatch (the default) is returned.
  1386.     
  1387.         Errors:
  1388.             badComponentInstance    invalid scripting component instance
  1389.             errOSASystemError
  1390. }
  1391. FUNCTION OSAExecuteEvent(scriptingComponent: ComponentInstance; {CONST}VAR theAppleEvent: AppleEvent; contextID: OSAID; modeFlags: LONGINT; VAR resultingScriptValueID: OSAID): OSAError;
  1392.     {$IFC NOT GENERATINGCFM}
  1393.     INLINE $2F3C, $0010, $0803, $7000, $A82A;
  1394.     {$ENDC}
  1395. {
  1396.         OSAComponentFunctionInline(kOSASelectExecuteEvent, 16);
  1397.         This call is similar to OSAExecute except the initial command to
  1398.         execute comes in the form of an AppleEvent.  If the contextID
  1399.         defines any event handlers for that event, they are used to process
  1400.         the event.  If no event handler can be found in the context
  1401.         errAEEventNotHandled is returned.  If an event handler is found and
  1402.         the hander "continues" control onward, the ResumeDispatchProc
  1403.         (registered with OSASetResumeDispatchProc, above) is called given the
  1404.         AppleEvent.  The result is returned as a scriptValueID.
  1405.     
  1406.         Errors:
  1407.             badComponentInstance    invalid scripting component instance
  1408.             errOSASystemError
  1409.             errOSAInvalidID
  1410.             errOSAScriptError:        the executing script got an error
  1411.             errAEEventNotHandled:    no handler for event in contextID
  1412.     
  1413.         ModeFlags:
  1414.             kOSAModeNeverInteract
  1415.             kOSAModeCanInteract
  1416.             kOSAModeAlwaysInteract
  1417.             kOSAModeCantSwitchLayer
  1418.             kOSAModeDontReconnect
  1419.             kOSAModeDoRecord
  1420. }
  1421. FUNCTION OSADoEvent(scriptingComponent: ComponentInstance; {CONST}VAR theAppleEvent: AppleEvent; contextID: OSAID; modeFlags: LONGINT; VAR reply: AppleEvent): OSAError;
  1422.     {$IFC NOT GENERATINGCFM}
  1423.     INLINE $2F3C, $0010, $0804, $7000, $A82A;
  1424.     {$ENDC}
  1425. {
  1426.         OSAComponentFunctionInline(kOSASelectDoEvent, 16);
  1427.         This call is similar to OSADoScript except the initial command to
  1428.         execute comes in the form of an AppleEvent, and the result is an 
  1429.         AppleEvent reply record.  If the contextID defines any event handlers
  1430.         for that event, they are used to process the event.  If no event handler
  1431.         can be found in the context errAEEventNotHandled is returned.  If an
  1432.         event handler is found and the hander "continues" control onward, the
  1433.         ResumeDispatchProc (registered with OSASetResumeDispatchProc, above) is
  1434.         called given the AppleEvent.  The result is returned in the form of an
  1435.         AppleEvent reply descriptor. If at any time the script gets an error, or
  1436.         if the ResumeDispatchProc returns a reply event indicating an error,
  1437.         then the OSADoEvent call itself returns an error reply (i.e. OSADoEvent
  1438.         should never return errOSAScriptError).  Any error result returned by
  1439.         the ResumeDispatchProc will be returned by OSADoEvent.
  1440.     
  1441.         Errors:
  1442.             badComponentInstance    invalid scripting component instance
  1443.             errOSASystemError
  1444.             errOSAInvalidID
  1445.             errAEEventNotHandled:    no handler for event in contextID
  1446.     
  1447.         ModeFlags:
  1448.             kOSAModeNeverInteract
  1449.             kOSAModeCanInteract
  1450.             kOSAModeAlwaysInteract
  1451.             kOSAModeCantSwitchLayer
  1452.             kOSAModeDontReconnect
  1453.             kOSAModeDoRecord
  1454. }
  1455. FUNCTION OSAMakeContext(scriptingComponent: ComponentInstance; {CONST}VAR contextName: AEDesc; parentContext: OSAID; VAR resultingContextID: OSAID): OSAError;
  1456.     {$IFC NOT GENERATINGCFM}
  1457.     INLINE $2F3C, $000C, $0805, $7000, $A82A;
  1458.     {$ENDC}
  1459. {
  1460.         OSAComponentFunctionInline(kOSASelectMakeContext, 12);
  1461.         Makes a new empty context which may be passed to OSAExecute or 
  1462.         OSAExecuteEvent.  If contextName is typeNull, an unnamed context is
  1463.         created. If parentContext is kOSANullScript then the resulting context
  1464.         does not inherit bindings from any other context.
  1465.     
  1466.         Errors:
  1467.             badComponentInstance    invalid scripting component instance
  1468.             errOSASystemError
  1469.             errOSAInvalidID
  1470.             errAECoercionFail:        contextName is invalid
  1471. }
  1472. {$ENDC}
  1473. {$ALIGN RESET}
  1474. {$POP}
  1475.  
  1476. {$SETC UsingIncludes := OSAIncludes}
  1477.  
  1478. {$ENDC} {__OSA__}
  1479.  
  1480. {$IFC NOT UsingIncludes}
  1481.  END.
  1482. {$ENDC}
  1483.